ATSUGetContinuousAttributes

OSStatus ATSUGetContinuousAttributes (
                     ATSUTextLayout iTextLayout,
                     UniCharArrayOffset iOffset,
                     UniCharCount iLength,
                     ATSUStyle oStyle);

iTextLayout

A reference of type ATSUTextLayout. Pass a reference to an initialized text layout object. You cannot pass NULL for this parameter.

iOffset

A value of type UniCharArrayOffset. Pass the edge offset of the beginning of the range of text whose continuous style run information you want to determine. To indicate the beginning of the text buffer, pass the constant kATSUFromTextBeginning, described in Text Offset Constant. If you pass an edge offset that is outside the text buffer, ATSUGetContinuousAttributes returns the result code kATSUInvalidTextRangeErr.

iRunLength

A value of type UniCharCount. Pass the length of the range of text whose continuous style run information you want to determine. To indicate the end of the text buffer, pass the constant kATSUToTextEnd, described in Text Length Constant. If you pass a length that is outside the text buffer, ATSUGetContinuousAttributes returns the result code kATSUInvalidTextRangeErr.

oStyle

A reference of type ATSUStyle. Pass a valid style object. On return, the contents of this object are filled with the continuous attributes. You cannot pass NULL for this parameter.

function result

A result code. See Result Codes.

DISCUSSION

The ATSUGetContinuousAttributes function finds the style run information that is continuous over a range of text, including the default values of unset attributes, font features, and font variations.

You should call ATSUGetContinuousAttributes to determine the style run information that remains constant over text that has been selected by the user. For example, the user might select the entire text block associated with a text layout object or a portion of it, then choose a different font family from your menu to render the text. ATSUGetContinuousAttributes will determine whether the style is plain, boldfaced, italicized, underlined, condensed, or extended.

If you want to find the style run information at a given location and the range of text that shares this information, call the function ATSUGetRunStyle.

VERSION NOTES

Available beginning with ATSUI 1.0.